jsdoc-parse

Parsing JSDoc comments

This feature allows you to parse JSDoc comments from JavaScript code and generate a JSON representation of the documentation. The code sample demonstrates how to parse a simple JSDoc comment and output the parsed JSON.

const jsdocParse = require('jsdoc-parse');
const fs = require('fs');

const jsdocComments = `
/**
 * Adds two numbers together.
 * @param {number} a - The first number.
 * @param {number} b - The second number.
 * @returns {number} The sum of the two numbers.
 */
function add(a, b) {
  return a + b;
}
`;

jsdocParse({ src: jsdocComments }).then(output => {
  console.log(JSON.stringify(output, null, 2));
});

Generating JSON output

This feature allows you to generate JSON output from JSDoc comments and save it to a file. The code sample demonstrates how to parse JSDoc comments and write the resulting JSON to a file named 'output.json'.

const jsdocParse = require('jsdoc-parse');
const fs = require('fs');

const jsdocComments = `
/**
 * Multiplies two numbers together.
 * @param {number} a - The first number.
 * @param {number} b - The second number.
 * @returns {number} The product of the two numbers.
 */
function multiply(a, b) {
  return a * b;
}
`;

jsdocParse({ src: jsdocComments }).then(output => {
  fs.writeFileSync('output.json', JSON.stringify(output, null, 2));
});